IAxis.Home method

Commands the axis to perform the "search home" sequence. The Position input is used to set the absolute position when an index signal is detected. This method completes at Standstill if it was started from Standstill.

Namespace: IntervalZero.KINGSTAR.Base.Class

Assembly: IntervalZero.KINGSTAR.Base.Class (in IntervalZero.KINGSTAR.Base.dll) Version: 4.4.0.0

Syntax

C#VB

IHomeCommand Home(
       double position,
       double velocity,
       double endVelocity,
       double acceleration,
       double deceleration,
       double jerk,
       McDirection direction,
       McHomingMode homingMode
)

Function Home(
       position As Double,
       velocity As Double,
       endVelocity As Double,
       acceleration As Double,
       deceleration As Double,
       jerk As Double,
       direction As McDirection,
       homingMode As McHomingMode
)As IHomeCommand

Parameters

position

Type: double

Sets absolute position when the index signal is detected. [unit]

velocity

Type: double

The start velocity of the homing move.

endVelocity

Type: double

The end velocity of the homing move. The usage depends on the homing mode.

acceleration

Type: double

The value for the acceleration.

deceleration

Type: double

The value for the deceleration.

jerk

Type: double

The value for the jerk.

direction

Type: McDirection

The direction the axis moves to home. Use the type 0, 2, or 3 in McDirection.

homingMode

Type: McHomingMode

Selects a homing mode.

Return value

Type: IHomeCommand

Returns the properties of homing.

Remarks

When using an incremental encoder, the motor's position is unknown when the motor is turned on. A known reference position must be searched to know the motor position. This is called homing.
In the homingSlave mode, the mcSlaveHomingMode and mcSlaveHomeOffset should be set first using the SlaveHomeOffset and SlaveHomingMode properties.